redeem
POST
/api/v1/accounts/:account_id/customers/:customer_id/customer_cards/:id/redeem
Redeem a reward
Redeems a reward for a customer, deducting the required stamps from their card. The customer must have enough stamps on this card to cover the reward’s cost. Triggers wallet pass updates and push notifications.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
account_id
|
Must be a number. | Required |
Store (account) ID |
customer_id
|
Must be a number. | Required |
Customer ID |
id
|
Must be a number. | Required |
Customer card ID |
reward_id
|
Must be a number. | Required |
Reward ID to redeem |
Error Codes
| Code | Description |
|---|---|
401
|
Unauthorized – invalid or missing API token |
404
|
Store, customer, customer card, or reward not found |
422
|
Redemption failed – not enough stamps or reward inactive |
Returns
Code: 200
The redemption that was recorded
| Name | Type | Required | Description |
|---|---|---|---|
success
|
Must be one of: true, false, 1, 0.
|
Required |
True when the reward was redeemed |
redemption
|
Must be a Hash | Required |
What was redeemed |
redemption[id]
|
Must be a Integer | Required |
Redemption ID |
redemption[reward_id]
|
Must be a Integer | Required |
Reward that was redeemed |
redemption[reward_name]
|
Must be a String | Required |
Display name of the reward |
redemption[stamps_spent]
|
Must be a Integer | Required |
Stamps deducted from the card |
redemption[stamps_remaining]
|
Must be a Integer | Required |
Stamps left on the card afterwards |
redemption[redeemed_at]
|
Must be a String | Required |
ISO 8601 timestamp of the redemption |